1. Introduction
Ce cours porte sur la Conception et Programmation Objet Avancée.
1.1. Concepts objets
Vous avez appris (cf. M2103 et M2104) un certain nombre de concepts objets :
-
Abstraction
-
Encapsulation
-
Héritage
-
Polymorphisme
1.1.1. Abstraction
Définition (restrictive) :
Une classe est une abstraction des caractéristiques communes d’un ensemble d’objets.
1.1.2. Encapsulation
Définition (restrictive) :
Dans la description d’un objet, le but de l'encapsulation est de masquer les attributs et les méthodes, c’est-à-dire, la manière dont est réalisé le comportement de l’objet.
1.1.3. Héritage
Définition (simpliste) :
L’héritage est la transmission de caractéristiques à ses descendants.
La classe qui hérite dispose des méthodes et attributs de niveau public et
protected de sa classe mère.
1.1.4. Polymorphisme
Le nom de polymorphisme vient du grec :
qui peut prendre plusieurs formes
|
L’héritage concerne les classes, le polymorphisme concerne les objets. |
On distingue généralement trois types de polymorphisme :
-
Le polymorphisme ad hoc (également surcharge ou en anglais overloading)
-
Le polymorphisme paramétrique (également généricité ou en anglais template)
-
Le polymorphisme d’héritage (également redéfinition, spécialisation ou en anglais overriding)
Polymorphisme ad hoc
-
Appelé aussi surcharge.
-
Permet d’avoir des fonctions de même nom dans des classes sans aucun rapport entre elles.
-
Permet de définir des opérateurs d’utilisation différente en fonction des paramètres.
int method(int,int);
int method(int);
int method(float,float);
Le polymorphisme paramétrique
Appelé aussi généricité.
interface Iterator<E> {
boolean hasNext();
E next();
}
public <T> static void copy(Collection<? extends T> source, Collection<? super T> dest) {
for (T t : source) {
dest.add(t);
}
}
Le polymorphisme d’héritage
-
Appelé aussi spécialisation (ou redéfinition).
-
Lié à la redéfinition des méthodes héritées.
1.2. Objectifs de la conception objet
On essaye d’éviter trois problèmes principaux du développement :
- La rigidité
-
Anticiper les évolutions susceptibles d’impacter l’application.
- La fragilité
-
Eviter les erreurs provoquées par la modification d’une partie du code.
- L’immobilité
-
Rendre moins difficile l’extraction d’une partie du code.
1.3. Bonnes pratiques et patrons
Pour répondre aux problèmes ci-dessus, on va s’attaquer à diminuer les dépendances et éviter l'"effet spaghetti".
Les qualités recherchées sont :
-
Robustesse : les changements n’introduisent pas de régressions.
-
Extensibilité : il est facile d’ajouter de nouvelles fonctionnalités.
-
Réutilisabilité : il est possible de réutiliser certaines parties de code pour construire d’autres applications.
Nous allons apprendre des bonnes pratiques :
-
Identifier les aspects qui varient et les séparer des aspects constants
-
Programmer une interface, non une implémentation
-
Préférer la composition à l’héritage
-
Les classes doivent être ouvertes à l’extension, mais fermées à la modification
-
Dépendez d’abstractions. Ne dépendez pas de classes concrètes (inversion des dépendances)
-
Ne parlez pas aux inconnus
L’étape suivante consiste à apprendre les bonnes solutions de conception, ce qu’on appelle les patrons de conception (ou design patterns en anglais).
1.4. Organisation du cours
|
Rappel du rythme : 1 cours, 1 TD et 2 TPs par semaine. Pendant 8 semaines. |
-
La première semaine est consacrée aux principes généraux des patrons de conception, en partant d’un exemple (cours en fin de semaine).
-
Les 5 ou 6 suivantes sont consacrées à l’étude de certains patrons classiques. Mise en pratique sur des exercices en TP.
Le cours est inversé par rapport aux habitudes : Conception et étude d’un ou plusieurs patrons semaine
N; mise en oeuvre en TP semaineN+1; puis cours en amphi (détails, discussions) en semaineN+2. -
Les 2 ou 3 dernières semaines, les étudiants sont en mode projet pour faire du refactoring d’applications réelles (conception aidée en TD sur les modèles UML™, mise en oeuvre en TP).
Voici une proposition de déroulement des semaines :
- Semaine 1
-
SuperCanard, le grand classique, Strategy
- Semaine 2
- Semaine 3
-
Patrons Le patron Fabrique, Proxy, Etat
- Semaine 4
-
-
-
version intuitive (2 interfaces)
-
version Java (classe
Observable)
-
-
- Semaine 5
-
L’exemple de Meyer : menus en objet
- Semaine 6
-
-
Patrons Décorateur, Façade, Visiteur
-
MVC avec l’exemple
JTablede Java -
Patrons Chaîne de responsabilité (juste en cours)
-
- Semaines 7 et 8
-
-
Quelques idées de projet final :
-
Refactorer un code généré par Umple.
-
Refactorer le code de MPA (mais pas le leur, celui d’un autre groupe)
-
-
1.5. Evaluation et notation
Comme prévu par le planning des contrôles, les étudiants auront :
-
une note de projet (TPs + projet final) ⇒ coef. 1
-
une note d’examen final (semaine 5) ⇒ coef. 2
2. Rappels sur des éléments Java importants
2.1. Importance du typage
2.1.1. Différents types de typage
Le fait d’attribuer un type (une classe) à une variable (un objet) peut se faire de plusieurs façons :
-
statique
-
dynamique
-
duck typing
2.1.2. Typage statique
On parle de typage statique quand la majorité des vérifications de type sont effectuées au moment de la compilation.
int i = 0; // cette déclaration indique explicitement que
// la variable i est de type entier
2.1.3. Typage dynamique
Le typage dynamique consiste à laisser l’ordinateur réaliser l’opération de typage à la volée, lors de l’exécution du code.
/**
* @author André Peninou
*/
public class Type {
void m() {
System.out.println ("Type");
}
}
public class SousType extends Type {
void m() {
System.out.println ("SousType");
}
void autreM(){
System.out.println ("Spécifique SousType");
}
}
...
Type a = new Type();
a.m(); // "Type"
a = new SousType();
a.m(); // "SousType"
// Statique : a est un Type (à la compil)
// Dynamique : a est un SousType au runtime.
// D'où :
a = new SousType();
a.autreM();
// NOK car type statique == A => autreM() n'existe pas à la compilation
...
2.1.4. Duck typing
Style de typage dynamique où la sémantique d’un objet (c’est-à-dire son type) est déterminée par l’ensemble de ses méthodes et de ses attributs, et non par un type défini et nommé explicitement par le programmeur.
|
L’origine de cette expression est liée à cette citation :
— James Whitcomb Riley
|
def calcule(a, b, c)
return a*b+c
end
$a = calcule(6, 3, 2)
$b = calcule('6', 3, ', the number of the beast')
puts $a.to_s
puts $b.to_s
Ce qui donne :
20 666, the number of the beast
| Pour aller plus loin : http://fr.wikipedia.org/wiki/Duck_typing |
2.2. Importance de la visibilité
Dès que l’on commence à avoir une application conséquente, l’organisation en package devient obligatoire. Revenons donc sur les questions de visibilité des propriétés et méthodes, qui seront importants dans la plupart des aspects de ce module.
Si un champ d’une classe A :
-
est private, il est accessible uniquement depuis sa propre classe ;
-
a la visibilité package (visibilité par défaut, pas de mot-clef), il est accessible de partout dans le paquetage de
Amais de nulle part ailleurs ; -
est protected, il est accessible de partout dans le paquetage de
Aet, siAest publique, grosso modo dans les classes héritant deAdans d’autres paquetages ; -
est public, il est accessible de partout dans le paquetage de
Aet, siAest publique, de partout ailleurs.
| Ci-dessus, les niveaux de visibilité sont rangés par visibilité croissante. |
package UN;
public class A {
protected String attrprotected;
String attrfriend; // friend
}
Si on définit une deuxième classe dans le même package :
package UN;
class B {
...
{
A a = new A ();
a.attrprotected// OK : même si bizarre
a.attrfriend // OK : visible package
}
}
package UN;
class C extends A {
...
{
this.attrprotected// OK : normal
this.attrfriend // OK : visible package
}
}
package DEUX;
class B {
...
{
A a = new A ();
a.attrprotected// NON OK : normal
a.attrfriend // NON OK : normal, proche de "private"
}
}
class C extends A {
...
{
this.attrprotected// OK : normal car protected et héritage
this.attrfriend // NON OK : normal, proche de "private"
}
}
À la question private ou protected ? Quel est le mieux pour les attributs ?
| Il n’y a pas de visibilité par défaut en UML™. |
2.3. Retour sur les Membres static
class VariableDemo
{
static int count=0;
public void increment()
{
count++;
}
public static void main(String args[])
{
VariableDemo obj1=new VariableDemo();
VariableDemo obj2=new VariableDemo();
obj1.increment();
obj2.increment();
System.out.println("Obj1: count is="+obj1.count);
System.out.println("Obj2: count is="+obj2.count);
}
}
Output:
Obj1: count is=2 Obj2: count is=2
2.3.1. Membres static (suite)
Comment ça marche :
-
Les variables
staticsont initialisées au chargement de la classe. -
Les variables
staticd’une classe sont initialisées avant que la moindre instance ne soit créée. -
Les variables
staticsont initialisées avant que la moindre méthodestaticne s’exécute.
2.3.2. Méthodes static
import java.lang.Math;
class Another {
public static void main(String[] args) {
int result;
result = Math.min(10, 20); //calling static method min by writing class name
System.out.println(result);
System.out.println(Math.max(100, 200));
}
}
2.3.3. Méthodes static et appel aux méthodes non-statiques
public class Main {
public static void main(String[] args) {
Main p = new Main();
k();
}
protected Main() {
System.out.print("1234");
}
protected void k() {
}
}
À l’exécution :
Main p = new Main(); // => prints 1234
k() // => raises error
Static method cannot call non-static methods
Bien sûr que si, sauf qu’il faut que cette dernière porte sur une instance de la classe.
Constructors are kind of a method with no return type.
En fait il vaudrait mieux les considérer comme une sorte de méthode statique. En effet elle ne requièrent pas de porter sur un objet!
2.4. Utilité générale des enum
2.4.1. Modélisation
Le type enumération est souvent utilisé en modélisation :
2.4.2. Propriétés
public enum Civilite {
MADAME, MONSIEUR
}
-
Chaque élément d’une énumération est un objet à part entière
-
Les objets
enumhéritent dejava.lang.Enum -
On peut compléter les comportements des objets en ajoutant des méthodes
2.4.3. Méthodes de base
-
toString()System.out.println(Civilite.MADAME); //MADAME -
valueOf()Civilite civilite = Civilite.valueOf("MONSIEUR") ; -
values()Civilite[] civilites = Civilite.values() ; -
ordinal()Civilite civilite = Civilite.MONSIEUR ; System.out.println("Civilite : " + civilite + " [" + civilite.ordinal() + "]") ; // Civilite : MONSIEUR [1]Le 1er numéro d’ordre est 0. -
compareTo()System.out.println(Civilite.MADAME.compareTo(Civilite.MONSIEUR)) ; // -1
2.4.4. Exemple plus complexe
public enum Langage {
//Objets directement construits
JAVA("Langage JAVA", "Eclipse"),
C ("Lanage C", "Code Block"),
CPlus ("Langage C++", "Visual studio"),
PHP ("Langage PHP", "PS Pad");
private String name = "";
private String editor = "";
//Constructeur
Langage(String name, String editor){
this.name = name;
this.editor = editor;
}
public void getEditor(){
System.out.println("Editeur : " + editor);
}
public String toString(){
return name;
}
public static void main(String args[]){
Langage l1 = Langage.JAVA;
Langage l2 = Langage.PHP;
l1.getEditor();
l2.getEditor();
}
}
3. Construire ses applications
Pour générer un programme, une documentation, à partir des sources, on peut :
-
Soit utiliser un environnement intégré comme eclipse
-
Soit construire les sorties (on parle de Build) à partir des sources
Nous nous intéressons dans cette section à cette deuxième catégorie.
Il existe plusieurs outils :
3.1. Les scripts
#!/bin/sh
UML='model.uml'
TYPE='PNG'
MAINPATH='/Users/bruel/localdev/cpoa'
DOCLETPATH=$MAINPATH/doclet
PUMLPATH=$MAINPATH/util
echo "Creating $UML..."
echo $DOCLETPATH
javadoc \
-private \
-quiet \
-J-DdestinationFile=$UML \
-J-DcreatePackages=false \
-J-DshowPublicMethods=true \
-J-DshowPublicConstructors=false \
-J-DshowPublicFields=true \
-doclet de.mallox.doclet.PlantUMLDoclet -docletpath $DOCLETPATH/plantUmlDoclet.jar \
-sourcepath . src/Canard.java src/Colvert.java
echo "Done creating plantUML model"
TYPE='png'
echo "Converting $UML to $TYPE..."
java -jar $PUMLPATH/plantuml.jar \
-config $PUMLPATH/config.cfg \
-t $TYPE $UML
echo "Done generating PNG from model"
set UML=TD1.uml
set TYPE='PNG'
set DOCLETPATH=E:\IUT-S3\CPOA\TP1\SuperCanardBof
echo "Creating %UML%..."
rem javadoc -private -quiet -J-DdestinationFile=%UML% -J-DcreatePackages=false -J-DshowPublicMethods=true -J-DshowPublicConstructors=false -J-DshowPublicFields=true -doclet de.mallox.doclet.PlantUMLDoclet -docletpath %DOCLETPATH%\plantUmlDoclet.jar src\canard\*.java
javadoc -J-DdestinationFile=%UML% -J-DcreatePackages=false -J-DshowPublicMethods=true -J-DshowPublicConstructors=false -J-DshowPublicFields=true -doclet de.mallox.doclet.PlantUMLDoclet -docletpath plantUmlDoclet.jar src\appli\*.java src\armes\*.java src\armes\impl\*.java
echo "Done."
set TYPE='png'
echo "Converting %UML% to %TYPE%..."
java -jar %DOCLETPATH%\plantuml.jar -config "%DOCLETPATH%\config.cfg" -t %TYPE% %UML%
echo "Done."
- Avantages
-
-
Faciles
-
Rapides
-
Beaucoup d’exemples
-
- Inconvénients
-
-
Pas portables sur d’autres systèmes (no comment ;-)
-
Peu lisibles
-
Peu évolutifs
-
3.2. make
1#-----------------------------------------------------
2ICONSDIR=images/icons
3IMAGESDIR=images
4STYLE=/Users/bruel/Dropbox/Public/dev/asciidoc/stylesheets/golo-jmb.css
5DOCTOR=asciidoctor -a icons -a iconsdir=$(ICONSDIR) -a images=$(IMAGESDIR) -a source-highlighter=$(HIGHLIGHT)
6DECK=swiss
7EXT=asc
8PANDOC=pandoc
9OUTPUT=.
10DEP=definitions.txt glossaire.txt refs.txt
11#-----------------------------------------------------
12
13all: $(OUTPUT)/*.html
14
15images/%.png: images/%.plantuml
16@echo '==> Compiling plantUML files to generate PNG'
17java -jar plantuml.jar $<
18
19%.html: %.$(EXT) $(DEP)
20@echo '==> Compiling asciidoc files with Asciidoctor to generate HTML'
21$(DOCTOR) -a toc2 -b html5 -a numbered -a eleve $<
22
23%.deckjs.html: %.$(EXT) $(DEP)
24@echo '==> Compiling asciidoc files to generate Deckjs'
25$(DOCTOR) -T /Users/bruel/dev/asciidoctor-backends/haml/deckjs/ -a slides \
26-a data-uri -a deckjs_theme=$(DECK) \
27-a icons -a iconsdir=$(ICONSDIR) \
28-a images=$(IMAGESDIR) -a prof -o $@ $<
29
30%-sujet.html: %.$(EXT) $(DEP)
31@echo '==> Compiling asciidoc files with Asciidoctor to generate HTML'
32$(DOCTOR) -a compact -a theme=compact -b html5 -a numbered -a eleve \
33-a data-uri $< -o $@
34
35%-prof.html: %.$(EXT) $(DEP)
36@echo '==> Compiling asciidoc files with Asciidoctor to generate HTML'
37$(DOCTOR) -a prof -a correction -a theme=compact -b html5 -a numbered \
38-a data-uri $< -o $@
%.html: %.$(EXT) $(DEP)
@echo '==> Compiling asciidoc files with Asciidoctor to generate HTML'
$(DOCTOR) -a toc2 -b html5 -a numbered -a eleve $<
Exemple d’utilisation :
$ make wip.html ==> Compiling asciidoc files with Asciidoctor to generate HTML asciidoctor -a icons -a iconsdir=images/icons -a images=images -a source-highlighter=pygments -a toc2 -b html5 -a numbered -a eleve wip.asc ... $ make wip.html make: 'wip.html' is up to date.
3.3. ant
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project default="main" name="EssaiBuild">
<target name="main">
<echo message="Version d'Ant utilisée: ${ant.version}"/>
<javadoc doclet="de.mallox.doclet.PlantUMLDoclet"
docletpath="plantUmlDoclet.jar"
access="private"
additionalparam=
"-encoding utf-8 -J-DdestinationFile=uml.txt -J-DcreatePackages=false -J-DshowPublicMethods=true -J-DshowPublicConstructors=false -J-DshowPublicFields=true"
>
<packageset dir="../src">
<include name="**"/>
</packageset>
</javadoc>
<java jar="plantuml.jar" fork="true" maxmemory="128m">
<arg value="uml.txt"/>
</java>
</target>
</project>
Exemple d’utilisation :
$ ant main Buildfile: build.xml main: [javadoc] Generating Javadoc [javadoc] Javadoc execution [javadoc] Loading source files for package pizzeriafactorysample... [javadoc] Constructing Javadoc information... [javadoc] PlantUMLDoclet.createPlantUml() - start [javadoc] open outputfile: uml.txt [javadoc] write interfaces/ abstract classes... [javadoc] write content... ... [javadoc] skip association for Pizza --> java.lang.String [javadoc] skip association for Pizza --> java.lang.String [javadoc] skip association for Pizza --> java.lang.String [javadoc] skip association for Pizza --> java.util.ArrayList [javadoc] PlantUMLDoclet.createPlantUml() - end BUILD SUCCESSFUL Total time: 9 seconds
Exemple d’tilisation dans eclipse pour la génération de fichier
du type TD.uml :
-
Créer un répertoire tools et mettre dedans :
-
Plantuml.jar -
Plantumldoclet.jar -
build.xml
-
-
Faire un Click_Droit sur
build.xmlet chosirBien choisir celui avec les points de suspensions.
-
Dans l’onglet
Environment:-
Créer une nouvelle variable de nom
Pathet de valeur : le répertoire de la JDK (où se trouvejavadocoujavadoc.exe)
-
-
Exécuter Run
Faire Refresh dans le navigateur pour voir les 2 fichiers générés ( uml.txtetuml.png). -
Il suffit de faire un Click_Droit sur
build.xmlet chosir (SANS les 3 points de suspensions) pour relancer la génération du diagramme.
3.4. Maven
Convention over Configuration
Exemples de conventions :
-
le code source est supposé se trouver dans
${basedir}/src/main/java -
les différentes ressources dans
${basedir}/src/main/resources -
les tests dans
${basedir}/src/test -
un projet est supposé produire un fichier
JAR -
Maven suppose que vous voulez compiler en bytecode dans
${basedir}/target/classes -
et ensuite créer votre fichier
JARdistribuable dans${basedir}/target
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.sonatype.mavenbook</groupId>
<artifactId>my-project</artifactId>
<version>1.0</version>
</project>
La commande :
$ mvn install
-
va traiter les ressources,
-
compiler le source,
-
exécuter les tests unitaires,
-
créer un JAR, et
-
installer ce JAR dans le dépôt local.
La commande :
$ mvn site
va créer un fichier index.html dans target/site contenant des liens vers
la JavaDoc et quelques rapports sur votre code source.
|
Pour comparer, voici l’équivalent ant :
|
3.5. Ivy
<ivy-module version="2.0">
<info organisation="org.apache" module="hello-ivy"/>
<dependencies>
<dependency org="commons-lang" name="commons-lang" rev="2.0"/>
<dependency org="commons-cli" name="commons-cli" rev="1.0"/>
</dependencies>
</ivy-module>
<project xmlns:ivy="antlib:org.apache.ivy.ant" name="hello-ivy" default="run">
...
<!-- =================================
target: resolve
================================= -->
<target name="resolve" description="--> retrieve dependencies with ivy">
<ivy:retrieve />
</target>
</project>
3.6. Graddle
Gradle combine la flexibilité de ant avec les conventions de Maven mais
évite les inconvénients de XML.
task hello {
doLast {
println 'Hello world!'
}
}
$ gradle hello :hello Hello world! BUILD SUCCESSFUL Total time: 3.486 secs
4. Design patterns
4.1. Introduction : importance des patrons
Science is what we understand well enough to explain to a computer. Art is everything else we do.
4.1.1. Strategy
Principes de conception
|
Principe de conception
|
|
Principe de conception
|
|
Principe de conception
|
Définition du patron
|
Design pattern : Stratégie (Strategy)
Stratégie définit une famille d’algorithmes, encapsule chacun d’eux et les rend interchangeables. Il permet à l’algorithme de varier indépendamment des clients qui l’utilisent. Figure 3. Modèle UML du patron Strategy
|
Premier exemple d’utilisation
|
Question
Pourquoi n’a-t’on pas utilisé Strategy pour afficher() ou nager()?
|
Autre exemple concret
| L’exemple qui suit est tiré de ce cours. |
Le problème
Vous avez une classe FileWriter qui a pour rôle d’écrire dans un fichier
ainsi qu’une classe DBWriter. Dans un premier temps, ces classes ne
contiennent qu’une méthode write() qui n’écrira que le texte passé
en paramètre.
Au fil du temps, vous vous rendez compte que c’est dommage qu’elles ne fassent que ça et vous aimeriez bien qu’elles puissent écrire en différents formats (HTML, XML, etc.) : les classes doivent donc formater puis écrire.
La solution
|
L’interface en
PHP (code source ici)
|
|
La classe abstraite
Writer (code source ici)
|
|
La classe
FileWriter (code source ici)
|
|
La classe
DBWriter (code source ici)
|
Enfin, nous avons nos trois formateurs.
L’un ne fait rien de particulier (TextFormater),
et les deux autres formatent le texte en deux langages
différents (HTMLFormater et XMLFormater).
|
La classe
TextFormater (code source ici)
La classe
HTMLFormater (code source ici)
La classe
XMLFormater (code source ici)
|
D’autres exemples
-
La fonction standard
sort()de python>>> sorted("This is a test string from Andrew".split(), key=str.lower) ['a', 'Andrew', 'from', 'is', 'string', 'test', 'This'] -
Stratégie de cryptage en fonction de la taille d’un fichier
File file = getFile(); Cipher c = CipherFactory.getCipher( file.size() ); c.performAction(); // implementations: interface Cipher { public void performAction(); } class InMemoryCipherStrategy implements Cipher { public void performAction() { // load in byte[] .... } } class SwaptToDiskCipher implements Cipher { public void performAction() { // swapt partial results to file. } }
| Plus de détails ici |
4.1.2. (non) Réutilisation
| Les patrons ne sont pas réutilisables! |
Il faut implémeter la solution qu’il représente à chaque fois.
Exception : certains font l’objet d’une librairie (comme Observer de Java).
Par exemple le patron Singleton existe dans la bibliothèque standard du langage en Ruby. C’est un mixin qu’il suffit d’inclure dans la classe qui doit être un singleton.
class Klass
include Singleton
# ...
end
a,b = Klass.instance, Klass.instance
a == b
# => true
Klass.new
# => NoMethodError - new is private ...
4.1.3. Association ou composition
On trouve deux modèles UML™ :
Et donc deux implémentations :
public class Colvert extends Canard {
protected Colvert() {
this(new VolerAvecDesAiles(), new Cancan());
}
...
c1 = new Colvert();
...
vol = new VolerAvecDesAiles();
cri = new Cancan();
c1 = new Colvert(vol,cri);
...
4.2. Un peu d’histoire
- 1977
-
Alexander : patterns pour les architectures (les vraies)
- 1987
-
Beck et Cunningham : patterns pour des interfaces utilisateurs
- 1988
-
Meyer : livre sur l’orienté objet (langage Eiffel), devenu la bible pour beaucoup de programmeurs (cf. [Meyer88])
- 1990-1995
-
Gamma, Helm, Johnson et Vlissides : LE livre de référence (cf. [GoF])
Les auteurs de ce livre sont connus comme les Gof pour « Gang of Four ». - 2003
-
Martin : principes SOLID (cf. [Martin03])
- 2004
-
Craig Larman décrit des modèles de conception : les Patterns GRASP (cf. [Larman05])
4.3. Exemples de bons principes
SOLID:
-
Single Responsibility Principle
-
Open-Closed Principle
-
Liskov Substitution Principle
-
Interface Segregation Principle
-
Dependency Inversion Principle
4.3.1. Single Responsibility Principle
Responsabilité => Sujet à changement
4.3.2. Open-Closed Principle
Ouvert à l'extension mais fermé à la modification
Ainsi, une fois écrite et testée, une classe ne devrait être modifiée que pour être corrigée! Toute modification devrait être possible par extension.
4.3.3. Liskov Substitution Principle
Barbara Liskov, pionnière en informatique et plus précisément en OO, a donné son nom à un principe important et bien connu : le principe default: substitution de Liskov. Elle a reçu l’équivalent du prix Nobel d’Informatique (le Turing Award) en 2009.
Une classe doit pouvoir être remplacée par une instance d'un de ses sous-types, sans modifier la cohérence du programme
Un carré est un rectangle particulier.
|
Question
Peut-on toujours substituer un Carré à la place d’un Rectangle ?
|
Rectangle.java)class Rectangle
{
protected int m_width;
protected int m_height;
public void setWidth(int width){
m_width = width;
}
public void setHeight(int height){
m_height = height;
}
public int getWidth(){
return m_width;
}
public int getHeight(){
return m_height;
}
public int getArea(){
return m_width * m_height;
}
}
Square.java)// Violation of Likov's Substitution Principle
class Square extends Rectangle
{
public void setWidth(int width){
m_width = width;
m_height = width;
}
public void setHeight(int height){
m_width = height;
m_height = height;
}
}
Square.java - suite)class LspTest
{
private static Rectangle getNewRectangle()
{
// it can be an object returned by some factory ...
return new Square();
}
public static void main (String args[])
{
Rectangle r = LspTest.getNewRectangle();
r.setWidth(5);
r.setHeight(10);
// User knows that r is a rectangle.
// It assumes that he's able to set the width and height as for the base class
System.out.println(r.getArea());
// Now she's surprised to see that the area is 100 instead of 50.
}
}
Rectangle.java)class LspTest
{
private static Square getNewSquare()
{
// it can be an object returned by some factory ...
return new Rectangle();
}
public static void main (String args[])
{
Square s = LspTest.getNewSquare();
s.setWidth(5);
// User knows that r is a rectangle.
// It assumes that he's able to set the width and height as for the base class
System.out.println(s.getArea());
// Now she's surprised to see that the area is 0 instead of 25.
}
}
4.3.4. Interface Segregation Principle
Préférer plusieurs interfaces spécifiques pour chaque client plutôt qu'une seule interface générale
4.3.5. Dependency Inversion Principle
Il faut dépendre des abstractions, pas des implémentations
Ce principe indique :
-
Les modules de haut niveau (abstraits) ne doivent pas dépendre des modules de bas niveau. Les deux doivent dépendre d’abstractions.
-
Les abstractions ne doivent pas dépendre des détails d’implémentation. C’est l’inverse : les détails doivent dépendre des abstractions.
| Ainsi ce principe va à l’encontre de l’intuition classique. |
4.3.6. SOLID et patrons
|
QUESTION
Lesquels des 5 principes SOLID s’appliquent bien à Strategy ? |
4.3.7. GRASP
The critical design tool for software development is a mind well educated in design principles. It is not the UML or any other technology.
2005
Il s’agit d’un ensemble de patrons, plutôt orientés conception (UML). Nous en aborderons certains au travers des exemples de ce module (cf. [Larman05]).
| Notez que les principes SOLID ne s’appliquent pas qu’à la programmation objet. Pour une discussion sur leur application avec React (language fonctionnel), cf. https://dev.to/shadid12/can-you-apply-solid-principles-to-your-react-applications-46il. |
4.4. Les patrons : comment ça marche ?
4.4.1. Intérêt
-
Réponses éprouvées à des problèmes récurrents
-
Vocabulaire commun
T’as qu’à utiliser une factory!
4.4.3. Patrons non abordés
-
Décorateur
-
Commande
-
Façade
-
Patron de méthode
-
Chaînes de responsabilité
-
Prototype
-
Mémento
-
Médiateur
-
Interprète
-
Poids-mouche
-
Monteur
-
Pont
5. Le patron Fabrique
5.1. Principes de conception
|
Design pattern : Fabrique (Factory)
Fabrique (simple) définit une interface pour la création d’un objet, mais en laissant à des sous-classes le choix des classes à instancier (voir aussi Fabrique abstraite). Figure 18. Modèle UML du patron Fabrique
|
5.3. Autre exemple concret
<?php
class DBFactory
{
public static function load($sgbdr)
{
$classe = 'SGBDR_' . $sgbdr;
if (file_exists($chemin = $classe . '.class.php'))
{
require $chemin;
return new $classe;
}
else
{
throw new RuntimeException('La classe <strong>' . $classe . '</strong> n\'a pu être trouvée !');
}
}
}
?>
<?php
try
{
$mysql = DBFactory::load('MySQL');
}
catch (RuntimeException $e)
{
echo $e->getMessage();
}
?>
public class XmlExprParser {
public static Expression fromFile(String file) throws ... {
SAXParserFactory spf = SAXParserFactory.newInstance();
spf.setValidating(true);
SAXParser sp = spf.newSAXParser();
ExprHandler ep = new ExprHandler();
sp.parse(file, ep);
return ep.getResult();
}
}
5.4. Un autre exemple concret
MazeGame ordinaryGame = new OrdinaryMazeGame();
MazeGame magicGame = new MagicMazeGame();
public abstract class MazeGame {
private final List<Room> rooms = new ArrayList<>();
public MazeGame() {
Room room1 = makeRoom();
Room room2 = makeRoom();
room1.connect(room2);
rooms.add(room1);
rooms.add(room2);
}
abstract protected Room makeRoom();
}
public abstract class Room {
abstract void connect(Room room);
}
public class MagicRoom extends Room {
public void connect(Room room) {}
}
public class OrdinaryRoom extends Room {
public void connect(Room room) {}
}
public class MagicMazeGame extends MazeGame {
@Override
protected Room makeRoom() {
return new MagicRoom();
}
}
public class OrdinaryMazeGame extends MazeGame {
@Override
protected Room makeRoom() {
return new OrdinaryRoom();
}
}
5.5. Mais c’est pas fini!
Reprenons nos pizzas vues en TD
-
Aucune variable ne doit contenir une référence à une classe concrète.
-
Aucune classe ne doit dériver d’une classe concrète.
-
Aucune classe ne doit redéfinir une méthode implémentée dans une classe de base.
public interface FabriqueIngredientsPizza {
public Pate creerPate ();
public Sauce creerSauce();
public Fromage creerFromage();
public Legumes[] creerLegumes();
public Poivrons creerPoivrons();
public Moules creerMoules();
}
public class FabriqueIngredientsPizzaBrest implements FabriqueIngredientsPizza {
public Pate creerPate() {
return new PateFine();
}
public Sauce creerSauce() {
return new SauceMarinara();
}
...
}
public class FabriqueIngredientsPizzaStrasbourg implements FabriqueIngredientsPizza {
public Pate creerPate() {
return new PateEpaisse();
}
public Sauce creerSauce() {
return new SauceTomateCerise();
}
...
}
public class PizzaFromage extends Pizza {
FabriqueIngredientsPizza fabriqueIngredients;
public PizzaFromage(FabriqueIngredientsPizza fabriqueIngredients) {
this.fabriqueIngredients = fabriqueIngredients;
}
void preparer() {
System.out.println("Préparation de " + nom);
pate = fabriqueIngredients.creerPate();
sauce = fabriqueIngredients.creerSauce();
fromage = fabriqueIngredients.creerFromage();
}
}
5.6. Fabrique abstraite
Nous sommes arrivé à une version du patron Fabrique appelée Fabrique Abstraite :
Fabrique (abstraite) fournit une interface pour la création de familles d’objets apparentés ou interdépendants, sans qu’il soit nécessaire de spécifier leurs classes concrètes (voir aussi Fabrique).
6. Un nouveau diagramme UML très utile
Les diagrammes d'états-transitions (plus simplement diagramme d’état) d’UML™ décrivent le comportement interne d’un objet à l’aide d’un automate à états finis.
Les notions importantes de ce diagramme :
-
états
-
actions
-
événements déclencheurs
-
signaux
-
invocations de méthode
-
6.1. Transitions
- Événement
-
Un signal, une invocation de méthode, etc.
- Condition
-
Un booléen
- Action
-
Affectation, invocation de méthode
6.2. Exemple de transitions
6.3. Refactoring
On peut remplacer les actions systématiques des transitions entrantes :
par une transition interne : entry :
6.4. Transitions internes
- entry
-
permet de spécifier une activité qui s’accomplit quand on entre dans l’état.
- exit
-
permet de spécifier une activité qui s’accomplit quand on sort de l’état.
- do
-
commence dès que l’activité
entryest terminée. Lorsque cette activité est terminée, une transition d’achèvement peut être déclenchée. Si une transition se déclenche pendant que l’activitédoest en cours, cette dernière est interrompue et l’activitéexitde l’état s’exécute.
6.5. Conditions
|
QUESTION
|
6.6. Etats complexes
Un état peut lui-même être doté d’un comportement et donc représenter à lui seul une machine à état. Par exemple :
|
QUESTION
Intégrez les semestres aux diagramme précédent (étudiants) |
6.7. Notion de concurrence
On peut représenter l’évolution de différentes machines de manière concurrente (parallèle). Par exemple :
|
QUESTION
Réalisez le diagramme d’état d’une machine à boisson rendant la monnaie. |
| Pour aller plus loin sur ce diagramme : http://laurent-audibert.developpez.com/Cours-UML/?page=diagramme-etats-transitions |
7. Etat
Soit la machine à état suivante :
7.1. Implémentation intuitive
public void insererPiece() {
if (etat == A_PIECE) {
System.out.println("Vous ne pouvez plus insérer de pièces");
} else if (etat == EPUISE) {
System.out.println("Vous ne pouvez pas insérer de pièce, nous sommes en rupture de stock");
} else if (etat == VENDU) {
System.out.println("Veuillez patienter, le bonbon va tomber");
} else if (etat == SANS_PIECE) {
etat = A_PIECE;
System.out.println("Vous avez inséré une pièce");
}
}
7.2. Erreur d’implémentations
-
Ce code n’adhère pas au principe Ouvert-Fermé.
-
Cette conception n’est pas orientée objet.
-
Les transitions ne sont pas explicites. Elles sont enfouies au milieu d’un tas d’instructions conditionnelles.
-
Nous n’avons pas encapsulé ce qui varie.
-
Les ajouts ultérieurs sont susceptibles de provoquer des bugs dans le code.
7.3. Une meilleure implémentation
-
Définir une nouvelle interface
Etatqui contiendra une méthode pour chaque action -
Implémenter une classe pour chaque
Etat. Elles seront responsable du comportement. -
Se débarrasser de toutes les instructions conditionnelles et les remplacer par une délégation à la classe adéquate.
7.4. Illutration
Etape 1 : les états comme implémentations d’une interface
Etape 2 : implémentation des méthodes de l’interface
public class EtatSansPiece implements Etat {
// Va falloir remplir ici...
public void insererPiece() {
System.out.println("Vous avez inséré une pièce");
// changer d'état si besoin
}
...
}
Etape 3 : utilisation
public class Distributeur {
Etat etat = new EtatSansPiece(); // état initial
...
public void insererPiece() {
etat.insererPiece(); // on délègue à l'état le soin de réagir
}
...
}
Etape 4 (enfin, retour sur l’étape 2) : une solution possible…
public class EtatSansPiece implements Etat {
Distributeur distributeur; // référence au distributeur qu'on gère
public EtatSansPiece(Distributeur distributeur) {
this.distributeur = distributeur;
}
public void insererPiece() {
System.out.println("Vous avez inséré une pièce");
distributeur.setEtat(distributeur.getEtatAPiece());
}
...
}
7.5. Le patron Etat
Etat permet à un objet de modifier son comportement, quand son état interne change. Tout se passe comme si l’objet changeait de classe.
|
QUESTION
Que pensez-vous de notre solution précédente par rapport à ce diagramme UML? |
L’état possède une référence vers le contexte (Distributeur dans notre exemple).
8. Qualité du code
8.1. À minima : option de votre EDI
Les éditeurs permettent souvent de régler le niveau de détail des informations proposées.
|
Par exemple, dans eclipse, on peut modifier le niveau de |
8.3. Sonar
L’outil SonarQube permet de "mesurer" les problèmes de qualité en dette technique (le temps requis pour remédier à la faible qualité)
Les aspects qui sont surtout considérés :
-
Bugs (réels ou potentiels)
-
Violation des standards de codage
-
Duplications de code
-
Manque de tests unitaires
-
Mauvaise distribution de la complexité
-
Code Spaghetti
-
Pas assez (ou trop) de commentaires
9. Coding Dojo
9.1. Rappel des principes
| Pour plus d’info sur le Coding Dojo : http://fr.wikipedia.org/wiki/Coding_Dojo |
9.1.1. Le principe :
-
Le prof de TP (ou le/la gentil(le) étudiant(e) volontaire désintéressé(e)) initie l’exercice en ouvrant un eclipse et en commençant un test qui commence par échouer et qui "passera" quand la fonctionalité attendue sera implémentée et fonctionnelle.
-
Il vérifie que son test échoue bien
On pourra avantageusement installer le plug-in eclipse InfiniTest qui permet de runner les tests à chaque sauvegarde (cf. plus haut) -
Il fait en sorte que le test passe au vert le plus vite possible
-
Il "refactor" éventuellement (faire passer le test au vert mais de façon intelligente, éviter la duplication de code, réorganiser les classes, etc.)
-
Quand tout est au vert on passe à une fonctionnalité suivante
9.1.2. Les règles
-
Toutes les 5 minutes (timer sonore) on change de personne aux commandes (au clavier/souris en l’occurence)
-
Il faut un "maître du temps"
-
Tout le monde participe au codage (et ne fait pas du code de son côté)
Les machines ne sont donc pas utiles pour cette partie! Seule la machine connectée au vidéoprojecteur est utilisée. -
Le volontariat c’est mieux, mais le prof est libre d’organiser le tour de rôle.
-
En 90' de TP on peut faire passer 18 personnes, donc tout le monde y passe et le plus tôt est en général le moins compliqué.
-
Merci à ceux qui ont déjà participé aux coding dojos de montrer l’exemple ;-)
9.2. Sujet du jour : Type Abstrait Pile
|
Rappels
CréerPile : -> Pile estVide : Pile -> Booléen Empiler : Pile * Elément -> Pile Dépiler : Pile -> Pile Sommet : Pile -> Elément
Sommet(p) valide Si et Seulement Si estVide(p) == FAUX Dépiler(p) valide Si et Seulement Si estVide(p) == FAUX
(1) estVide(CréerPile()) (2) estVide(Empiler(p,e)) == FAUX (3) estVide(Dépiler(Empiler(p,e))) Si et Seulement Si estVide(p) (4) Sommet(Empiler(p,e)) == e (5) !estVide(p) => Sommet(Dépiler(Empiler(p,e))) == Sommet(p) L’axiome suivant résume à lui seul les axiomes (3) et (5) : Dépiler(Empiler(p,e)) == p |
|
Choix d’implémentation
Le type abstrait Pile sera implémenté en java en utilisant un tableau de chaines de caractères. Dans un premier temps, la taille du tableau sera de 10 éléments.
|
Pour l’architecture logicielle, le type abstrait Pile sera composé :
-
d’une classe Pile fournissant un enregistrement de type Pile
-
d’une classe PileOperations fournissant toutes les opérations du type Abstrait Pile
| Les étapes qui suivent ne sont pas complètement adaptées au dojo car souvent les tests se font après coup, mais vous pourrez avoir le code sous la main pour lancer les inspirations si elles ne viennent pas. |
9.3. Étape 1 : Mise en place d’un enregistrement de type Pile
-
Commencer par un test simple et le placer dans un fichier de nom PileTest.java. Essayez de l’avoir en tête et de ne juste "ouvrir" un ficher déjà prêt. L’intérêt du coding dojo, c’est de voir comment vous utiliser les raccourcis, les quickfix etc.
import junit.textui.TestRunner; import junit.framework.TestSuite; import junit.framework.TestCase; public class PileTest extends TestCase { static int totalAssertions = 0; static int bilanAssertions = 0; /* Opérations du type Pile */ public void test_type_new_Pile() throws Exception { Pile pile = new Pile() ; totalAssertions++ ; assertEquals("new Pile() retourne une Pile", "Pile", pile.getClass().getName()); bilanAssertions++ ; } /* Axiomes du type Pile */ /* Préconditions du type Pile */ /* main() de la classe de Test */ public static void main(String[] args) { junit.textui.TestRunner.run(new TestSuite(PileTest.class)); if (bilanAssertions == totalAssertions) { System.out.print("Bravo !"); } System.out.println(" "+bilanAssertions+"/"+totalAssertions+" assertions vérifiées"); } // fin main } // fin PileTest -
Si vous utilisez SciTE au lieu de eclipse, pour compiler le programme de Test n’oubliez pas de placer les fichiers SciTE.properties et junit.jar dans le répertoire de vos sources (avant d’ouvrir SciTE) ou bien exécutez ceci :
javac -cp .;junit.jar PileTest.java
-
Compléter la classe Pile pour qu’elle fournisse un enregistrement possédant :
-
un champ elements de type String[] et de taille 100
-
un champ indiceSommet de type int, initialisé à -1
-
9.4. Étape 2 : Mise en place des opérations du type abstrait Pile
-
Créer un fichier PileOperations.java et y placer une classe PileOperations contenant la fonction empiler() suivante :
public static Pile empiler(Pile pfPile, String pfElement) { return(pfPile); } -
Compiler Pile.java puis vérifier que le test passe toujours
-
Ajouter la fonction de test suivante à PileTest.java
Seconde fonction de testpublic void test_type_empiler() throws Exception { Pile pile = new Pile() ; totalAssertions++ ; assertEquals("empiler(pile,'XXX') retourne une Pile", "Pile", PileOperations.empiler(pile,"XXX").getClass().getName()); bilanAssertions++ ; }Comprendre cette seconde fonction de test, compiler PileTest.java puis vérifier que les 2 tests passent.
-
Ajouter la fonction de test suivante à PileTest.java
Troisième fonction de testpublic void test_type_depiler() throws Exception { Pile pile = new Pile() ; PileOperations.empiler(pile,"XXX") ; totalAssertions++ ; assertEquals("depiler(pile) retourne une Pile", "Pile", PileOperations.depiler(pile).getClass().getName()); bilanAssertions++ ; }Comprendre cette troisième fonction de test et compléter PileOperations.java pour que le troisième test passe.
-
Ajouter la fonction de test suivante à PileTest.java
Quatrième fonction de testpublic void test_type_sommet() throws Exception { Pile pile = new Pile() ; PileOperations.empiler(pile,"XXX") ; totalAssertions++ ; assertEquals("sommet(pile) retourne une String", "java.lang.String", PileOperations.sommet(pile).getClass().getName()); bilanAssertions++ ; }Comprendre cette quatrième fonction de test et compléter LE MOINS POSSIBLE PileOperations.java pour que le quatrième test passe.
| à ce stade, les opérations du type Pile respectent seulement la définition des types requis et produits. Les opérations ne font pas encore ce qu’elle doivent faire. Patience … |
9.5. Étape 3 : Implémentation des axiomes du type abstrait Pile (si vous avez encore du temps)
L’implémentation java du type Pile utilise un tableau de chaines et une variable indice indiquant le sommet actuel de la pile.
-
Que doit contenir le tableau interne d’une Pile à la suite des actions suivantes :
Pile p = new Pile(); PileOperations.empiler(p,"A"); PileOperations.empiler(p,"B"); PileOperations.depiler(p); PileOperations.depiler(p); -
Pourquoi le code précédent est-il equivalent à celui-ci :
Pile p = new Pile(); PileOperations.depiler(PileOperations.depiler(PileOperations.empiler(PileOperations.empiler(p,"A"),"B"))); -
Ajouter le code suivant à PileTest.java
Test des axiomes du type abstrait Pilepublic void XXXtest_axiome1() { Pile pile = new Pile() ; totalAssertions++ ; assertTrue("Une nouvelle pile est vide", PileOperations.estVide(pile)); bilanAssertions++ ; } public void XXXtest_axiome2() throws Exception { Pile pile = new Pile() ; PileOperations.empiler(pile,"XXX") ; totalAssertions++ ; assertFalse("Apres empiler() : pile n'est pas vide", PileOperations.estVide(pile)); bilanAssertions++ ; } public void XXXtest_axiome3() throws Exception { Pile pile = new Pile() ; PileOperations.empiler(pile,"XXX") ; PileOperations.depiler(pile) ; totalAssertions++ ; assertTrue("Apres empiler(), depiler() : pile est vide", PileOperations.estVide(pile)); bilanAssertions++ ; } public void XXXtest_axiome4() throws Exception { Pile pile = new Pile() ; PileOperations.empiler(pile,"XXX") ; totalAssertions++ ; assertEquals("Apres empiler(pile,\"XXX\") : Sommet == \"XXX\"", "XXX", PileOperations.sommet(pile)); bilanAssertions++ ; } public void XXXtest_axiome5() throws Exception { Pile pile = new Pile() ; PileOperations.empiler(pile,"000") ; PileOperations.empiler(pile,"XXX") ; PileOperations.depiler(pile) ; totalAssertions++ ; assertEquals("Apres empiler(pile,\"000\"), empiler(pile,\"XXX\"), depiler(pile) : Sommet == \"000\"", "000", PileOperations.sommet(pile)); bilanAssertions++ ; } public void XXXtest_axiomes3et5() throws Exception { Pile pile = new Pile() ; PileOperations.depiler(PileOperations.empiler(PileOperations.empiler(pile,"000"),"XXX")) ; totalAssertions++ ; assertEquals("Apres empiler(pile,\"000\"), empiler(pile,\"XXX\"), depiler(pile) : Sommet == \"000\"", "000", PileOperations.sommet(pile)); bilanAssertions++ ; PileOperations.depiler(pile) ; totalAssertions++ ; assertTrue("Apres depiler(pile) : pile est vide", PileOperations.estVide(pile)); bilanAssertions++ ; } -
POUR chaque fonction de test FAIRE
-
Activer la fonction en supprimant 'XXX'
-
Comprendre l’objectif
-
Modifier la classe PileOperations pour que le test passe
-
Compiler, tester
-
Retourner en c) autant que nécessaire
Indications-
empiler() incrémente le sommet de pile, puis insère le nouvel élément à l’indice sommet de pile
-
depiler() décrémente le sommet de pile
-
sommet() retourne l’élément situé en sommet de pile
-
Vous supposerez dans cet exercice que la pile n’est jamais pleine
-
-
10. Observateur
10.1. Motivation
10.2. Définition
Observateur définit une relation entre objets de type un-à-plusieurs, de façon que, lorsqu’un objet change d’état, tous ceux qui en dépendent en soient notifiés et soient mis à jour automatiquement.
10.3. Application
Le patron Observer est utilisable dans de nombreuses situations :
-
Quand un concept a deux aspects, l’un dépendant de l’autre. Encapsuler ces aspects dans des objets séparés permet de les utiliser et les laisser évoluer de manière indépendante.
-
Dès que le changement d’un objet entraîne le changement de plusieurs autres.
-
Dès qu’un objet doit en notifier un certain nombre d’autres sans les connaitre.
10.4. Observer en Java
Java fournit des classes Observable/Observer pour le patron Observer.
La classe java.util.Observable est la classe de base pour les sujets.
Ainsi, toute classe qui veut être observée étant cette classe dont
voici les caractéristiques :
-
fournit des méthodes pour ajouter/enlever des observateurs
-
fournit des méthodes pour notifier les observateurs
-
une sous-classe concrète doit seulement s’occuper de notifier à chque méthode modifiant l’état des objets (mutators)
-
utilise un vecteur stoquant les références des observateurs
L’interface java.util.Observer correspond aux observateurs
qui doivent implémenter cette interface.
10.4.1. La classe java.util.Observable
Voici la liste des méthodes de java.util.Observable :
1public Observable()
2public synchronized void addObserver(Observer o)
3protected synchronized void setChanged()
4public synchronized void deleteObserver(Observer o)
5protected synchronized void clearChanged()
6public synchronized boolean hasChanged()
7public void notifyObservers(Object arg)
8public void notifyObservers()
10.4.2. L’interface java.util.Observer
1/**
2* This method is called whenever the observed object is changed. An
3* application calls an observable object's notifyObservers method to have all
4* the object's observers notified of the change.
5*
6* Parameters:
7* o - the observable object
8* arg - an argument passed to the notifyObservers method
9*/
10public abstract void update(Observable o, Object arg)
11. Une implémentation du MVC : les JTable java
11.1. Le principe
11.2. L’architecture
12. Adaptateur
12.1. Le problème
On veut pouvoir :
-
utiliser une classe existante, mais dont l’interface ne coïncide pas avec celle escomptée.
-
créer une classe réutilisable qui collabore avec des classes sans relations avec elle et encore inconnues, c’est-à-dire avec des classes qui n’auront pas nécessairement des interfaces compatibles.
-
vous avez besoin d’utiliser plusieurs sous-classes existantes, mais l'adaptation de leur interface par dérivation de chacune d’entre elles est impraticable. Un adaptateur objet peut adapter l’interface de sa classe parente.
Ce dernier cas ne concerne que le cas "adaptateur d’objet"
12.2. Exemple concret : le retour des canards
-
L’existant :
public interface Canard {
public void cancaner();
public void voler();
}
public class Colvert implements Canard {
public void cancaner() {
System.out.println("Coincoin");
}
public void voler() {
System.out.println("Je vole");
}
}
-
Le "presque canard" :
public interface Dindon {
public void glouglouter();
public void voler();
}
public class DindonSauvage implements Dindon {
public void glouglouter() {
System.out.println("Glouglou");
}
public void voler() {
System.out.println("Je ne vole pas loin");
}
}
Vous êtes à court d’objets Canard et vous aimeriez utiliser des objets Dindon à la place!
public class AdaptateurDindon implements Canard {
Dindon dindon;
...
public void cancaner() {
dindon.glouglouter();
}
public void voler() {
// Adaptation du vol
for(int i=0; i < 5; i++) {
dindon.voler();
}
}
}
12.3. Le patron Adaptateur
Adaptateur (Adaptor) permet de convertir l’interface d’une classe en une autre conformément à l’attente du client. L’Adaptateur permet à des classes de collaborer, alors qu’elles n’auraient pas pu le faire du fait d’interfaces incompatibles.
13. Le patron Visiteur
13.1. Le problème
Quelques situations à problème :
-
Une structure d’objets contient beaucoup de classes différentes d’interfaces distinctes, et vous désirez réaliser des opérations sur ces objets qui dépendent de leurs classes concrètes.
-
Il s’agit d’effectuer plusieurs opérations distinctes et sans relation entre elles, sur les objets d’une structure, et ceci en évitant de polluer leurs classes avec ces opérations.
-
Les classes qui définissent la structure objet changent rarement, mais on doit souvent définir de nouvelles opérations sur cette structure.
13.2. Illustration
Adapté d’un exemple tiré de http://www.tutorialspoint.com/design_pattern/visitor_pattern.htm
13.2.1. Step 1
Définir une interface pour représenter les éléments de la structure.
public interface ComputerPart {
...
}
13.2.2. Step 2
Anticiper l’utilisation du visiteur.
public interface ComputerPartVisitor {
...
}
public interface ComputerPart {
public void accept(ComputerPartVisitor computerPartVisitor);
}
13.2.3. Step 3
Créer les classes concrètes qui implémentent l’interface.
public class Keyboard implements ComputerPart {
@Override
public void accept(ComputerPartVisitor computerPartVisitor) {
computerPartVisitor.visit(this);
}
}
…
public class Computer implements ComputerPart {
ComputerPart[] parts;
public Computer(){
parts = new ComputerPart[] {new Mouse(), new Keyboard(), new Monitor()};
}
@Override
public void accept(ComputerPartVisitor computerPartVisitor) {
for (int i = 0; i < parts.length; i++) {
parts[i].accept(computerPartVisitor);
}
computerPartVisitor.visit(this);
}
}
13.2.4. Step 4
Définir l’interface pour représenter le visiteur.
public interface ComputerPartVisitor {
public void visit(Computer computer);
public void visit(Mouse mouse);
public void visit(Keyboard keyboard);
public void visit(Monitor monitor);
}
13.2.5. Step 5
Créer des visiteurs concrets.
public class DisplayVisitor implements ComputerPartVisitor {
@Override
public void visit(Computer computer) {
System.out.println("Displaying Computer.");
}
@Override
public void visit(Mouse mouse) {
System.out.println("Displaying Mouse.");
}
@Override
public void visit(Keyboard keyboard) {
System.out.println("Displaying Keyboard.");
}
@Override
public void visit(Monitor monitor) {
System.out.println("Displaying Monitor.");
}
}
13.2.6. Step 6
Utiliser le visiteur DisplayVisitor.
public class VisitorPatternDemo {
public static void main(String[] args) {
ComputerPart computer = new Computer();
computer.accept(new DisplayVisitor());
}
}
13.2.7. Step 7 (final)
Verify the output.
Displaying Mouse.
Displaying Keyboard.
Displaying Monitor.
Displaying Computer.
13.3. Le patron Visiteur
Visiteur (Visitor) permet la représentation d’une opération applicable aux éléments d’une structure d’objet.
Il définit une nouvelle opération, sans qu’il soit nécessaire de modifier la classe des éléments sur lesquels elle agit.
13.4. Avantages/Inconvénients
Avantages :
-
Permet d’ajouter des opérations à la structure d’un Composite sans modifier la structure elle-même.
-
L'ajout de nouvelles opérations est relativement facile.
-
Le code des opérations exécutées par le Visiteur est centralisé.
Inconvénients :
-
L’encapsulation des classes du Composite est brisée.
-
Comme une fonction de navigation est impliquée, les modifications de la structure du Composite sont plus difficiles.
13.5. Exemples d’utilisation
-
calcul sur un ensemble structuré d’éléments
-
génération de rapports ou de code
-
…
13.6. Exemple concret d’utilisation en Java
| Exemple tiré de ce site. |
public interface ItemElement {
public int accept(ShoppingCartVisitor visitor);
}
public class Book implements ItemElement {
private int price;
private String isbnNumber;
public Book(int cost, String isbn){
this.price=cost;
this.isbnNumber=isbn;
}
public int getPrice() {
return price;
}
public String getIsbnNumber() {
return isbnNumber;
}
@Override
public int accept(ShoppingCartVisitor visitor) {
return visitor.visit(this);
}
}
public class Fruit implements ItemElement {
private int pricePerKg;
private int weight;
private String name;
public Fruit(int priceKg, int wt, String nm){
this.pricePerKg=priceKg;
this.weight=wt;
this.name = nm;
}
public int getPricePerKg() {
return pricePerKg;
}
public int getWeight() {
return weight;
}
public String getName(){
return this.name;
}
@Override
public int accept(ShoppingCartVisitor visitor) {
return visitor.visit(this);
}
}
public interface ShoppingCartVisitor {
int visit(Book book);
int visit(Fruit fruit);
}
public class ShoppingCartVisitorImpl implements ShoppingCartVisitor {
@Override
public int visit(Book book) {
int cost=0;
//apply 5$ discount if book price is greater than 50
if(book.getPrice() > 50){
cost = book.getPrice()-5;
} else cost = book.getPrice();
System.out.println("Book ISBN::"+book.getIsbnNumber() + " cost ="+cost);
return cost;
}
@Override
public int visit(Fruit fruit) {
int cost = fruit.getPricePerKg()*fruit.getWeight();
System.out.println(fruit.getName() + " cost = "+cost);
return cost;
}
}
public class ShoppingCartClient {
public static void main(String[] args) {
ItemElement[] items = new ItemElement[]{new Book(20, "1234"),new Book(100, "5678"),
new Fruit(10, 2, "Banana"), new Fruit(5, 5, "Apple")};
int total = calculatePrice(items);
System.out.println("Total Cost = "+total);
}
private static int calculatePrice(ItemElement[] items) {
ShoppingCartVisitor visitor = new ShoppingCartVisitorImpl();
int sum=0;
for(ItemElement item : items){
sum = sum + item.accept(visitor);
}
return sum;
}
}
Book ISBN::1234 cost =20 Book ISBN::5678 cost =95 Banana cost = 20 Apple cost = 25 Total Cost = 160
14. Proxy
14.1. Le problème
On a besoin de références à un objet, qui soient plus créatives et plus sophistiquées qu’un simple pointeur.
14.2. Le patron Proxy
Procuration (Proxy) fournit à un tiers un mandataire ou un remplaçant, pour contrôler l’accès à cet objet.
14.3. Utilisations
-
Une procuration à distance fournit un représentant local d’un objet situé dans un espace adresse différent.
-
Une procuration virtuelle crée des objets lourds à la demande.
-
Une procuration de protection contrôle l’accès à l’objet original. Les procurations de protection sont utiles quand les objets doivent satisfaire différents droits d’accès.
-
Une référence intelligente est le remplaçant d’un pointeur brut, qui réalise des opérations supplémentaires, lors de l’accès à l’objet. Quelques utilisations typiques sont :
-
décompte du nombre des références faites à un objet réel, de sorte que celui-ci puisse être libéré automatiquement, dés qu’il n’y a plus de références ;
-
charger en mémoire un objet persistant quand il est référencé pour la première fois ;
-
vérifier, avant d’y accéder, que l’objet réel est verrouillé, pour être sûr qu’aucun autre objet ne pourra le changer.
-
14.4. Exemple concret : RMI
Remote Method Invocation est une méthode d’accès à un service à distance.
import java.rmi.*;
public interface MonService extends Remote {
public String direBonjour() throws RemoteException;
}
import java.rmi.*;
import java.rmi.server.*;
public class MonServiceImpl extends UnicastRemoteObject implements MonService {
public String direBonjour() {
return "Le serveur dit 'Bonjour'";
}
public MonServiceImpl() throws RemoteException {}
public static void main (String[] args) {
try {
MonService service = new MonServiceImpl();
Naming.rebind("BonjourDistant", service);
} catch(Exception ex) {
ex.printStackTrace();
}
}
}
MonService service =
(MonService) Naming.lookup("rmi://127.0.0.1/BonjourDistant");
...
service.direBonjour();
15. Itérateur
15.1. Le problème
On veut pouvoir :
-
pour accéder au contenu d’un objet d’un agrégat sans en révéler la représentation interne ;
-
pour gérer simultanément plusieurs parcours dans des agrégats d’objets ;
-
pour offrir une interface uniforme pour les parcours au travers de diverses structures agrégats (c’est-à-dire, pour permettre l’itération polymorphe).
15.2. Le patron Itérateur
Itérateur (Iterator) fournit un moyen d’accès séquentiel aux éléments d’un agrégat d’objets, sans mettre à découvert la représentation interne de celui-ci.
15.3. Exemple concret
Voici un exemple en Ruby :
# Saluer tout le monde
def say_hi
if @names.nil?
puts "..."
elsif @names.respond_to?("each")
# @names est une liste de noms : traitons-les uns par uns
@names.each do |name|
puts "Hello #{name}!"
end
else
puts "Hello #{@names}!"
end
end
16. Le patron Composite
16.1. Le problème
On veut pouvoir :
-
représenter des hiérarchies de l’individu.
-
que le client n’ait pas à se préoccuper de la différence entre "combinaisons d’objets" et "objets individuels". Les clients pourront traiter de façon uniforme tous les objets de la structure composite.
16.2. Le patron Composite
Composite permet de composer des objets en des structures arborescentes pour représenter des hiérarchies composant/composé. Permet au client de traiter d’une façon unique les objets et les combinaisons d’objets.
16.3. Exemple concret
import java.util.ArrayList;
interface Graphic {
public void print();
}
class CompositeGraphic implements Graphic {
private ArrayList<Graphic> mChildGraphics = new ArrayList<Graphic>();
public void print() {
for (Graphic graphic : mChildGraphics) {
graphic.print();
}
}
public void add(Graphic graphic) {
mChildGraphics.add(graphic);
}
public void remove(Graphic graphic) {
mChildGraphics.remove(graphic);
}
}
16.4. un "Anti" exemple
Que pensez-vous de cette définition de Composite ?
| On appelle ces modèles des "Patrons abîmés" (anti-patterns). |
17. Retour sur le refactoring Banque
17.1. Le problème
Remplacer tous ces switch cases
continuer = true;
while (continuer) {
AAB.afficherMenu(monAg);
choix = lect.next();
choix = choix.toLowerCase();
switch (choix) {
...
case "p" :
System.out.print("Propriétaire -> ");
nom = lect.next();
AAB.comptesDUnPropretaire (monAg, nom);
break;
...
-
Afficher une liste séparemment du switch
//AAB.afficherMenu(monAg); System.out.println("Menu de " + ag.getNomAgence() + " (" + ag.getLocAgence() + ")"); System.out.println("l - Liste des comptes de l'agence"); ... System.out.println("p - voir les comptes d'un Propriétaire (par son nom)"); ... System.out.print("Choix -> "); } -
Tester tous les choix pour actionner la bonne option
... case "p" : System.out.print("Propriétaire -> "); nom = lect.next(); AAB.comptesDUnPropretaire (monAg, nom); break; ...
17.2. Une solution
-
Des listes
-
Des options de menu qui encapsulent l’action à réaliser
public interface ActionList extends Action {
public String listTitle();
public int size();
public boolean addAction(Action ac);
public boolean removeAction(Action ac);
public String[] listOfActions() ;
}
public interface Action {
public String actionMessage ();
public void execute(AgenceBancaire ag);
}
public class Action1 implements Action {
private String lineMessage;
...
public String actionMessage() {
return this.lineMessage;
}
public void execute(AgenceBancaire ab) {
...
ab.afficher();
}
}
action.execute(ab);
Action a1 = new Action1("Liste des comptes de l'agence");
Action a2 = new Action2("Voir un compte (par son numéro)");
Action a3 = new Action3(...);
ActionList al1 = new ActionListAgenceBancaire("Menu Général");
al1.addAction(a1);
al1.addAction(a2);
public void execute(AgenceBancaire ab) throws Exception {
...
while (true) {
this.printMenu();
choice = this.readResponse();
...
this.myMenu.get(choice).execute(ab);
...
public interface ActionList extends Action {
}
18. Pour aller plus loin avec les patrons…
18.1. Partagez votre vocabulaire
-
Dans les réunions de conception (pas nécessairement avec le client)
-
Avec les autres développeurs
-
Dans la documentation de votre architecture
-
Dans les commentaires du code et les conventions de nommage
-
Dans les groupes/blogs de développeurs
-
(pas pendant les exams!)
18.2. Ne foncez pas tête baissée
Quelques conseils :
-
Les patterns sont des outils, non des règles.
⇒ Rien n’empêche de les modifier et de les adapter à votre problème.
-
Ne visez l’extensibilité que si la question se pose réellement dans la pratique, pas si elle est uniquement hypothétique.
-
Ne vous emballez pas et recherchez la simplicité.
⇒ Si vous trouvez une solution plus simple que l’emploi d’un pattern, n’hésitez pas !
-
éliminez ce qui n’est pas vraiment nécessaire.
⇒ N’ayez pas peur de supprimer un design pattern inutile de votre conception.
18.3. Les autres types de patrons
Il n’y a pas que les 3 types de patrons que l’on a vu :
-
De création
-
Structurels
-
Comportementaux
Il y a par exemple :
-
Les patrons d’architecture
-
Les patrons d’application
-
Les patrons de domaine
-
Les patrons de processus
-
Les patrons d’organisation
-
Les patrons de conception d’interfaces utilisateur
18.4. Les anti-patrons
-
Des solutions souvent appliquées à tort à des problèmes récurrents
-
Décrit comment partir d’un problème pour arriver à une mauvaise solution
-
Vous dit pourquoi une mauvaise solution est attrayante
-
Suggère d’autres patrons applicables pouvant fournir de meilleures solutions
18.5. Tous les patrons qu’on a pas vu
Il y en a beaucoup :
-
Chaîne de responsabilité
-
Commande
-
Décorateur
-
Façade
-
Interprète
-
Médiateur
-
Mémento
-
Monteur
-
Patron de méthode
-
Poids-mouche
-
Pont
-
Prototype
18.6. Injection de dépendances
Nous n’avons pas le temps de traiter ce point, mais cf. par exemple https://blog.angularindepth.com/why-do-we-have-dependency-injection-in-web-development-f8815e593b38.
Glossaire et définition
| Ces définitions reprennent les définitions vues dans ce livre, en les organisant par grands types de patrons de conception : de création, comportementaux et structurels. |
Patrons de création
- Singleton
-
Singleton garantit qu’une classe n’a qu’une seule instance et fournit un point d’accès global à cette instance.
- Fabrique
-
Fabrique (simple) définit une interface pour la création d’un objet, mais en laissant à des sous-classes le choix des classes à instancier (voir aussi Fabrique abstraite).
- Fabrique abstraite
-
Fabrique (abstraite) fournit une interface pour la création de familles d’objets apparentés ou interdépendants, sans qu’il soit nécessaire de spécifier leurs classes concrètes (voir aussi Fabrique).
Patrons comportementaux
- État (Stateuk)
-
Etat permet à un objet de modifier son comportement, quand son état interne change. Tout se passe comme si l’objet changeait de classe.
- Itérateur (Iteratoruk)
-
Itérateur (Iterator) fournit un moyen d’accès séquentiel aux éléments d’un agrégat d’objets, sans mettre à découvert la représentation interne de celui-ci.
- Observateur (Observeruk)
-
Observateur définit une relation entre objets de type un-à-plusieurs, de façon que, lorsqu’un objet change d’état, tous ceux qui en dépendent en soient notifiés et soient mis à jour automatiquement.
- Stratégie (Strategyuk)
-
Stratégie définit une famille d’algorithmes, encapsule chacun d’eux et les rend interchangeables. Il permet à l’algorithme de varier indépendamment des clients qui l’utilisent.
- Visiteur (Visitoruk)
-
Visiteur (Visitor) permet la représentation d’une opération applicable aux éléments d’une structure d’objet. Il définit une nouvelle opération, sans qu’il soit nécessaire de modifier la classe des éléments sur lesquels elle agit.
Patrons structurels
- Adaptateur (Adaptoruk)
-
Adaptateur (Adaptor) permet de convertir l’interface d’une classe en une autre conformément à l’attente du client. L’Adaptateur permet à des classes de collaborer, alors qu’elles n’auraient pas pu le faire du fait d’interfaces incompatibles.
- Composite
-
Composite permet de composer des objets en des structures arborescentes pour représenter des hiérarchies composant/composé. Permet au client de traiter d’une façon unique les objets et les combinaisons d’objets.
- Procuration (Proxyuk)
-
Procuration (Proxy) fournit à un tiers un mandataire ou un remplaçant, pour contrôler l’accès à cet objet.
Références
-
[Cysboy] Apprenez à programmer en Java. Par
cysboy. Disponible ici (le 2022-01-12). -
[Freeman04] Design Pattren - Head First. Bert Bates, Eric Freeman, Elisabeth Freeman, Kathy Sierra. O’Reilly, 09/2004.
-
[Freeman05] Tête la première : Design Pattern. Bert Bates, Eric Freeman, Elisabeth Freeman, Kathy Sierra. Editions O’Reilly. 2005.
-
[GoF] Design Patterns: Elements of reusable object oriented software. 1994.
-
GOPROD - De bonnes pratiques au service de la conception orientée objets. Disponible ici (le 2022-01-12).
-
[Larman05] Larman, Craig. Applying UML and Patterns – An Introduction to Object-Oriented Analysis and Design and Iterative Development (3rd ed.). Prentice Hall. 2005. ISBN 0-13-148906-2.
-
[Martin03] “Principles Of OOD”, Robert C. Martin (“Uncle BOB”), http://butunclebob.com.
-
[Meyer88] Meyer, Bertrand. Object-Oriented Software Construction. Prentice Hall. 1988. ISBN 0-13-629049-3.
-
[SOLID] https://blogs.msdn.microsoft.com/cdndevs/2009/07/15/the-solid-principles-explained-with-motivational-posters/